11.2 Consultar turmas

Request

Request

query AcademicClasses {
    academicClasses(take: 1) {
        items {
            class
            academicSerieId
            id
            refId
            externalId
            creationDate
            active
            deleted
            lastUpdateDate
        }
        totalCount
        pageInfo {
            hasNextPage
            hasPreviousPage
        }
    }
}

Params

Parâmetro	Tipo	Descrição
skip	Int	Número de registros a serem pulados no início da coleção. Utilizado para paginação.
take	Int	Número máximo de registros a serem retornados. Utilizado para paginação.
where	AcademicClassFilterInput	Objeto que define os critérios de filtragem para as turmas.
order	[AcademicClassSortInput!]	Array de objetos que definem a ordem de classificação dos resultados.

Objeto AcademicClassFilterInput

Campo	Tipo	Descrição
academicSerie	AcademicSerieFilterInput	Filtro para a série da turma
academicSerieId	IntOperationFilterInput	Filtro para o ID da série da turma
active	BooleanOperationFilterInput	Filtro para o status de ativação da turma
and	[AcademicClassFilterInput!]	Combina filtros usando a lógica AND
changes	ListFilterInputTypeOfLogHistoryFilterInput	Filtro para o histórico de alterações da turma
class	StringOperationFilterInput	Filtro para o nome da turma
creationDate	DateTimeOperationFilterInput	Filtro para a data de criação da turma
deleted	BooleanOperationFilterInput	Filtro para o status de deleção da turma
externalId	IntOperationFilterInput	Filtro para o ID externo da turma
id	IntOperationFilterInput	Filtro para o ID do objeto da requisição da turma
lastUpdateDate	DateTimeOperationFilterInput	Filtro para a data da última atualização da turma
or	[AcademicClassFilterInput!]	Combina filtros usando a lógica OR
refId	UuidOperationFilterInput	Filtro para o ID de referência da turma

Objeto AcademicClassSortInput

Campo	Tipo	Descrição
academicSerie	AcademicSerieSortInput	Critério de ordenação para a série da turma
academicSerieId	SortEnumType	Critério de ordenação para o ID da série da turma
active	SortEnumType	Critério de ordenação para o status de ativação da turma
class	SortEnumType	Critério de ordenação para o nome da turma
creationDate	SortEnumType	Critério de ordenação para a data de criação da turma
deleted	SortEnumType	Critério de ordenação para o status de deleção da turma
externalId	SortEnumType	Critério de ordenação para o ID externo da turma
id	SortEnumType	Critério de ordenação para o ID do objeto da requisição da turma
lastUpdateDate	SortEnumType	Critério de ordenação para a data da última atualização da turma
refId	SortEnumType	Critério de ordenação para o ID de referência da turma

Response

Response

{
    "data": {
        "academicClasses": {
            "items": [
                {
                    "class": "A",
                    "academicSerieId": 2,
                    "id": 1,
                    "refId": "f26786f2-709a-481c-a33b-9c81a5b918e0",
                    "externalId": null,
                    "creationDate": "2024-05-20T20:37:51.323Z",
                    "active": true,
                    "deleted": false,
                    "lastUpdateDate": null
                }
            ],
            "totalCount": 23,
            "pageInfo": {
                "hasNextPage": true,
                "hasPreviousPage": false
            }
        }
    }
}

Result

Campo	Tipo	Descrição
academicClasses	AcademicClassesCollectionSegment	Coleção de turmas

Objeto AcademicClassesCollectionSegment

Campo	Tipo	Descrição
items	[AcademicClass!]	Lista de objetos do tipo AcademicClass
pageInfo	CollectionSegmentInfo!	Informações para auxiliar na paginação dos resultados.
totalCount	Int!	Número total de registros encontrados, independentemente da paginação.